Place API
How to use the API
Here is an overview of the features included in this API, what they do and what you can use them for:
| API Feature | What it does | What it's used for |
|---|---|---|
| Get API Version | Retrieves the full version number of the API. | Viewing the API version. |
| Get Place By ID | Retrieves the matching address/location information for a supplied Place ID. | Where the Place ID is known, this feature can be used to obtain the exact address/location. Note: 0-1 results expected. |
| Get Places By Query - Address | Retrieves a list of matching addresses of supplied address data. | Obtaining all possible matches of addresses for a search request. Can be used to search for a customer's address. |
| Get Places By Query - PLSAM ID | Retrieves the matching address/location information of a supplied PLSAM ID. | Where the PLSAM ID is known, this feature can quickly obtain the address associated with a PLSAM ID. Note: 0-1 results expected. |
| Get Places By Query - TUI ID | Retrieves the matching address/location information of a supplied TUI ID. | Where the TUI ID is known, this feature can be used to quickly obtain an address associated with a TUI ID. Note: 0-1 results expected. |
| Get Places By Query - Product ID | Retrieves matching address/location information of a supplied Product ID. | Where the Product ID is known, this feature can be used to quickly obtain an address associated with a Product ID. Note: 0-1 results expected. |
| Get Places By Query - ONT Serial Number | Retrieves the matching address/location information of a supplied ONT Serial Number. | Where the ONT Serial Number is known, this feature can be used to quickly obtain associated address of ONT Serial Number ID supplied. Note: 0-1 results expected. |
| Get Site Information By ID | Retrieves Chorus associated information for an address/location of a supplied Place ID. | Used to obtain relevant information associated to address or location including: - Network Location Information, such as MDU/ROW consent and build statuses, fibre availability and install type - intact ONTs at location that are available to be activated - active Product IDs and the ONT they are connected to - open orders and the ONT they will be connected to. |
Note: Where other providers are currently requesting an install at a location or have active products, these providers are not identified and only generic product names are returned.